home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / artlog10.zip / ARTLOG.DOC next >
Text File  |  1993-02-15  |  13KB  |  457 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                         The Art Log Entry Generator 1.0
  22.  
  23.                          A TequilaNetmailware Product
  24.                    Copyright (c)1993 by Philippe Feuerstein
  25.                                2:323/3@fidonet
  26.  
  27.  
  28.  
  29.  
  30.                                   User Guide
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.                                 - Page 1 -
  66.  
  67.                                             The Art Log Entry Generator 1.0
  68.  
  69.  
  70.    ╓───────────────────────────────────────────────────────────────────────╖
  71.    ║ ▒▒▒▒ Table of contents ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  72.    ╙───────────────────────────────────────────────────────────────────────╜
  73.  
  74.  
  75.        1. Features . . . . . . . . . . . . . . . .3
  76.  
  77.        2. Legal Notice . . . . . . . . . . . . . .3
  78.  
  79.        3. Requirements . . . . . . . . . . . . . .4
  80.  
  81.        4. Installation . . . . . . . . . . . . . .4
  82.  
  83.        5. The Template File / Macros . . . . . . .4
  84.  
  85.        6. Running ArtLog . . . . . . . . . . . . .5
  86.  
  87.        7. Exit Error Levels. . . . . . . . . . . .6
  88.  
  89.        8. The TequilaNetmailware Concept . . . . .6
  90.  
  91.        9. Support. . . . . . . . . . . . . . . . .7
  92.  
  93.       10. Credits. . . . . . . . . . . . . . . . .7
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.                                 - Page 2 -
  131.  
  132.                                             The Art Log Entry Generator 1.0
  133.  
  134.  
  135.    ╓───────────────────────────────────────────────────────────────────────╖
  136.    ║ ▒▒▒▒ 1. Features ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  137.    ╙───────────────────────────────────────────────────────────────────────╜
  138.  
  139.        The Art Log Entry Generator is a little utility for people using
  140.        logfiles of their computer activity and having software that
  141.        does not write a log entry... or writing log entries in an
  142.        unsuitable format.
  143.  
  144.        With ArtLog, you use a template for your log entries with macros
  145.        for the date and time format, and you can pass up to 9
  146.        parameters.
  147.  
  148.        You can even use environment variables in your templates, giving
  149.        you a powerful and flexible method of making and modifying
  150.        templates.
  151.  
  152.        Templates are of unlimited length (depending only on available
  153.        memory), so you can use ArtLog for other usage than logging :-))
  154.        (have a look on Mailing.Tpl)
  155.  
  156.        ArtLog writes to stdout, can be redirected and piped as you
  157.        want.
  158.  
  159.  
  160.    ╓───────────────────────────────────────────────────────────────────────╖
  161.    ║ ▒▒▒▒ 2. Legal Notice ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  162.    ╙───────────────────────────────────────────────────────────────────────╜
  163.  
  164.        The Art Log Entry Generator comes with limited warranty: it will
  165.        occupy disk space.
  166.  
  167.        The Art Log Entry Generator is provided as is, without any other
  168.        warranty of any kind, either expressed or implied.
  169.  
  170.        In no event shall Philippe Feuerstein be liable to you or
  171.        anyone else for any damages, including any lost profits, lost
  172.        savings or other incidental or consequential damages arising
  173.        out of the use or inability to use The Art Log Entry Generator.
  174.  
  175.        The Art Log Entry Generator is not public domain, shareware or
  176.        freeware; it is TequilaNetmailware!
  177.  
  178.        You are allowed to use The Art Log Entry Generator for an
  179.        evaluation period of thirty days. After this period you MUST
  180.        send me a TequilaNetmail (see below).
  181.  
  182.        You are allowed to distribute The Art Log Entry Generator on BBS,
  183.        Shareware, Disk, CD-Rom as long as:
  184.  
  185.              - The ArtLog archive contains unmodified copies of the
  186.                following files: ■ ARTLOG.EXE
  187.                                 ■ ARTLOG.DOC
  188.                                 ■ TEQUILA.REG
  189.                                 ■ All the *.TPL files
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                 - Page 3 -
  196.  
  197.                                             The Art Log Entry Generator 1.0
  198.  
  199.  
  200.              - No fee is charged.
  201.  
  202.              - You don't run a commercial BBS or a French Minitel server.
  203.  
  204.  
  205.  
  206.  
  207.    ╓───────────────────────────────────────────────────────────────────────╖
  208.    ║ ▒▒▒▒ 3. Requirements ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒║
  209.    ╙───────────────────────────────────────────────────────────────────────╜
  210.  
  211.        ■ An IBM AT or 100% compatible PC (286, 386 or 486 processor)
  212.  
  213.        ■ MS-DOS, PC-DOS or DR-DOS version 3.00 or later. (Tested with 4Dos)
  214.  
  215.        ■ An accurate computer clock!
  216.  
  217.  
  218.  
  219.  
  220.    ╓───────────────────────────────────────────────────────────────────────╖
  221.    ║ ▒▒▒▒ 4. Installation ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  222.    ╙───────────────────────────────────────────────────────────────────────╜
  223.  
  224.        The installation is very easy: just put ArtLog.Exe in any
  225.        directory...
  226.  
  227.        Create or edit the template(s) file(s) that match your needs.
  228.  
  229.  
  230.  
  231.  
  232.    ╓───────────────────────────────────────────────────────────────────────╖
  233.    ║ ▒▒▒▒ 5. The Template File / Macros ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  234.    ╙───────────────────────────────────────────────────────────────────────╜
  235.  
  236.        The template files are plain vanilla ASCII. All of its content,
  237.        including white spaces, will go in your generated log. You can use
  238.        high ASCII characters.
  239.  
  240.        The name of the template file MUST have the .TPL extension!!!
  241.  
  242.        You can use a set of macros in it; the macros are all prefixed
  243.        with the character &.
  244.  
  245.        Available Macros:
  246.  
  247.        &a: Day name, 3 chars   (Mon, Tue, Wed, Thu, Fri, Sat, Sun)
  248.        &A: Day name, full
  249.        &d: Day number in month (01-31)
  250.        &j: Day number in year  (001-366)
  251.  
  252.        &b: Month name, 3 chars (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug,
  253.                                 Sep, Oct, Nov, )
  254.        &B: Month name, full
  255.        &m: Month number        (01-12)
  256.  
  257.  
  258.  
  259.  
  260.                                 - Page 4 -
  261.  
  262.                                             The Art Log Entry Generator 1.0
  263.  
  264.  
  265.  
  266.        &y: Year, 2 numbers     (00-99)
  267.        &Y: Year, 4 numbers     (1900-1999)
  268.  
  269.        &H: Hour 24 hours format
  270.        &I: Hour 12 hours format
  271.        &p: AM/PM
  272.        &M: Minutes             (00-59)
  273.        &S: Seconds             (00-59)
  274.  
  275.        &&: the '&' character
  276.  
  277.        &1-&9: first to ninth optional command line parameter.
  278.  
  279.        &%: This one is very powerful, announcing an environment variable,
  280.            which must follow without any space: &%RA will insert the value
  281.            of your environment variable RA (if set, of course...)
  282.  
  283.        Have a look at the supplied templates that output the classical log
  284.        format in BBS/Mailers software as well as other samples...
  285.  
  286.  
  287.  
  288.  
  289.    ╓───────────────────────────────────────────────────────────────────────╖
  290.    ║ ▒▒▒▒ 6. Running ArtLog ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  291.    ╙───────────────────────────────────────────────────────────────────────╜
  292.  
  293.        The general format of the command line for ArtLog is:
  294.  
  295.        ArtLog <Template> [arg1] [arg2] [...] [arg9] [>>Logfile]
  296.  
  297.        The first parameter is mandatory: the name of the template file
  298.        to use; if you omit the TPL extension, ArtLog will add it internaly,
  299.        so "ArtLog Test" is equivalent to "ArtLog Test.Tpl".
  300.  
  301.        The templates are searched in the specified directory, in the
  302.        current directory and if not found, in the ArtLog.Exe directory.
  303.  
  304.        Then you can specify up to 9 string parameters that will be used
  305.        by the &1 to &9 macros.
  306.  
  307.        The last thing you should do is to redirect the output to your
  308.        logfile :-))
  309.  
  310.        Seems complex? Try this, using the supplied templates:
  311.  
  312.        ArtLog Fd_Head.Tpl "System Information"          >> Yourlog
  313.        ArtLog Fd.Tpl      "The time supplied by ArtLog" >> Yourlog
  314.  
  315.        But, ArtLog has many more uses:
  316.        Try the Mailing.Btm (4Dos) that will use the Mailing.Tpl
  317.  
  318.        For the &%VAR trick, try ArtLog Env_Var.Tpl  >> Yourlog
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.                                 - Page 5 -
  326.  
  327.                                             The Art Log Entry Generator 1.0
  328.  
  329.  
  330.  
  331.  
  332.    ╓───────────────────────────────────────────────────────────────────────╖
  333.    ║ ▒▒▒▒ 7. Exit Error Levels ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  334.    ╙───────────────────────────────────────────────────────────────────────╜
  335.  
  336.        The Art Log Entry Generator always returns an errorlevel on exit.
  337.  
  338.        Here are the errorlevels and their meanings:
  339.  
  340.             0: No Error, Normal Termination
  341.             1: Argument Error
  342.             2: Registration Key Error
  343.             3: Read Template Error
  344.             4: Memory Error
  345.  
  346.  
  347.  
  348.  
  349.    ╓───────────────────────────────────────────────────────────────────────╖
  350.    ║ ▒▒▒▒ 8. The TequilaNetmailware Concept and the Registration ▒▒▒▒▒▒▒▒▒ ║
  351.    ╙───────────────────────────────────────────────────────────────────────╜
  352.  
  353.        This program was written for my own use, as I wanted to log
  354.        the time of my BBS computer reboot as well as the start and
  355.        end of my nightly backup in my Front Door/Remote Access Log.
  356.  
  357.        The longest and most boring part was to write this f...... doc
  358.        you are reading right now!
  359.  
  360.        So I think it would be unlegitimate for me to ask you any money
  361.        for it. But then again, it's not exactly freeware ....
  362.  
  363.        Because I would like to know how many people are using The Art
  364.        Log Entry Generator, and also because I like Tequila, I'm asking
  365.        you, if you use ArtLog, to send me a Netmail telling me that next
  366.        time we will meet (who knows...) you'll offer me a Tequila!
  367.  
  368.        You can use the Tequila.Reg file for registering and you can send
  369.        or upload it on any of the specified registration site:
  370.  
  371.        Zone 2:
  372.        Send to:    Philippe Feuerstein, 2:323/3@fidonet
  373.        or
  374.        Upload on:  L'Art Des Choix! (+33) 75-67-61-64 14400 HST V32bis
  375.  
  376.        Germany:
  377.        Send to:    Peter Hampf, 2:240/11@fidonet
  378.        or
  379.        Upload on:  Granny's Inn (+49) 4441-5404 14400 HST V32bis
  380.  
  381.        Zone 1:
  382.        Send to:    Richard Transue, 1:300/15@fidonet
  383.        or
  384.        Upload on:  Meredith Place BBS   602-579-0869 14400 HST V32bis
  385.  
  386.  
  387.  
  388.  
  389.  
  390.                                 - Page 6 -
  391.  
  392.                                             The Art Log Entry Generator 1.0
  393.  
  394.  
  395.        If you do so, you will get a "registration" key to get rid of the
  396.        annoying opening delay; if you don't the delay will be more and
  397.        more annoying: 1" more every 5 runs with a max of 20".
  398.  
  399.        Remember, you MUST send me a Netmail and offer me a Tequila
  400.        next time we meet!!!
  401.  
  402.        If you really want to send me money, don't refrain!!!
  403.  
  404.  
  405.  
  406.  
  407.    ╓───────────────────────────────────────────────────────────────────────╖
  408.    ║ ▒▒▒▒ 9. Support ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  409.    ╙───────────────────────────────────────────────────────────────────────╜
  410.  
  411.        Send any comments/suggestions/bug reports/questions to:
  412.  
  413.            Philippe Feuerstein, 2:323/3@fidonet
  414.  
  415.        or
  416.  
  417.        Leave a message in the ARTNODE conference on the support BBS:
  418.  
  419.            L'Art Des Choix!   (+33) 75-67-61-64     14400 HST V32bis
  420.  
  421.  
  422.  
  423.  
  424.    ╓───────────────────────────────────────────────────────────────────────╖
  425.    ║ ▒▒▒▒ 10. Credits ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ║
  426.    ╙───────────────────────────────────────────────────────────────────────╜
  427.  
  428.        Many thanks to Michel Barthelemy, Peter Hampf, Edmond Vandermeersch,
  429.        Richard Transue. They were foolish enough to test the betas...
  430.  
  431.        Special mega-greetings to Peter Hampf for his suggestions!
  432.  
  433.        Special mega-greetings to Richard Transue for the doc revision.
  434.  
  435.        4DOS is a trademark of J.P. Software / R.C. Conn and T. Rawson.
  436.  
  437.        ARTLOG is a trademark of Philippe Feuerstein :-)
  438.  
  439.        BORLAND C++ is a trademark of Borland International.
  440.  
  441.        DR-DOS is a trademark of Digital Research.
  442.  
  443.        MS-DOS is a trademark of Microsoft Corporation.
  444.  
  445.        PC-DOS is a trademark of IBM.
  446.  
  447.        REGKEY is a trademark of Brian Pirie.
  448.  
  449.        TEQUILA is a true pleasure :-)
  450.  
  451.  
  452.  
  453.  
  454.  
  455.                                 - Page 7 -
  456.  
  457.